---
layout: typedoc
title: '@msrvida/sanddance'
---
<header>
<div class="tsd-page-title">
	<div class="typedoc-container">
	</div>
</div>
</header>
<div class="container container-main">
<div class="row">
	<div class="col-8 col-content">
		<section class="tsd-panel-group tsd-index-group">
			<h2>Index</h2>
			<section class="tsd-panel tsd-index-panel">
				<div class="tsd-index-content">
					<section class="tsd-index-section ">
						<h3>Namespaces</h3>
						<ul class="tsd-index-list">
							<li class="tsd-kind-namespace"><a href="modules/vegadeckgl.html" class="tsd-kind-icon">Vega<wbr>Deck<wbr>Gl</a></li>
							<li class="tsd-kind-namespace"><a href="modules/constants.html" class="tsd-kind-icon">constants</a></li>
							<li class="tsd-kind-namespace"><a href="modules/searchexpression.html" class="tsd-kind-icon">search<wbr>Expression</a></li>
							<li class="tsd-kind-namespace"><a href="modules/specs.html" class="tsd-kind-icon">specs</a></li>
							<li class="tsd-kind-namespace"><a href="modules/types.html" class="tsd-kind-icon">types</a></li>
							<li class="tsd-kind-namespace"><a href="modules/util.html" class="tsd-kind-icon">util</a></li>
						</ul>
					</section>
					<section class="tsd-index-section ">
						<h3>Classes</h3>
						<ul class="tsd-index-list">
							<li class="tsd-kind-class"><a href="classes/viewer.html" class="tsd-kind-icon">Viewer</a></li>
						</ul>
					</section>
					<section class="tsd-index-section ">
						<h3>Variables</h3>
						<ul class="tsd-index-list">
							<li class="tsd-kind-variable"><a href="modules.html#colorschemes" class="tsd-kind-icon">color<wbr>Schemes</a></li>
							<li class="tsd-kind-variable"><a href="modules.html#version" class="tsd-kind-icon">version</a></li>
						</ul>
					</section>
					<section class="tsd-index-section ">
						<h3>Functions</h3>
						<ul class="tsd-index-list">
							<li class="tsd-kind-function"><a href="modules.html#use" class="tsd-kind-icon">use</a></li>
						</ul>
					</section>
				</div>
			</section>
		</section>
		<section class="tsd-panel-group tsd-member-group ">
			<h2>Variables</h2>
			<section class="tsd-panel tsd-member tsd-kind-variable">
				<a name="colorschemes" class="tsd-anchor"></a>
				<h3><span class="tsd-flag ts-flagConst">Const</span> color<wbr>Schemes</h3>
				<div class="tsd-signature tsd-kind-icon">color<wbr>Schemes<span class="tsd-signature-symbol">:</span> <a href="interfaces/types.colorscheme.html" class="tsd-signature-type" data-tsd-kind="Interface">ColorScheme</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div>
				<aside class="tsd-sources">
					<ul>
						<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance/src/colorSchemes.ts#L20">sanddance/src/colorSchemes.ts:20</a></li>
					</ul>
				</aside>
				<div class="tsd-comment tsd-typography">
					<div class="lead">
						<p>Array of color schemes.</p>
					</div>
				</div>
			</section>
			<section class="tsd-panel tsd-member tsd-kind-variable">
				<a name="version" class="tsd-anchor"></a>
				<h3><span class="tsd-flag ts-flagConst">Const</span> version</h3>
				<div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;DEBUG&#x27;</span></div>
				<aside class="tsd-sources">
					<ul>
						<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance/src/version.ts#L4">sanddance/src/version.ts:4</a></li>
					</ul>
				</aside>
			</section>
		</section>
		<section class="tsd-panel-group tsd-member-group ">
			<h2>Functions</h2>
			<section class="tsd-panel tsd-member tsd-kind-function">
				<a name="use" class="tsd-anchor"></a>
				<h3><span class="tsd-flag ts-flagConst">Const</span> use</h3>
				<ul class="tsd-signatures tsd-kind-function">
					<li class="tsd-signature tsd-kind-icon">use<span class="tsd-signature-symbol">(</span>vega<span class="tsd-signature-symbol">: </span><a href="interfaces/vegadeckgl.types.vegabase.html" class="tsd-signature-type" data-tsd-kind="Interface">VegaBase</a>, deck<span class="tsd-signature-symbol">: </span><a href="interfaces/vegadeckgl.types.deckbase.html" class="tsd-signature-type" data-tsd-kind="Interface">DeckBase</a>, layers<span class="tsd-signature-symbol">: </span><a href="interfaces/vegadeckgl.types.decklayerbase.html" class="tsd-signature-type" data-tsd-kind="Interface">DeckLayerBase</a>, luma<span class="tsd-signature-symbol">: </span><a href="interfaces/vegadeckgl.types.lumabase.html" class="tsd-signature-type" data-tsd-kind="Interface">LumaBase</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
				</ul>
				<ul class="tsd-descriptions">
					<li class="tsd-description">
						<aside class="tsd-sources">
							<ul>
								<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance/src/index.ts#L13">sanddance/src/index.ts:13</a></li>
							</ul>
						</aside>
						<h4 class="tsd-parameters-title">Parameters</h4>
						<ul class="tsd-parameters">
							<li>
								<h5>vega: <a href="interfaces/vegadeckgl.types.vegabase.html" class="tsd-signature-type" data-tsd-kind="Interface">VegaBase</a></h5>
							</li>
							<li>
								<h5>deck: <a href="interfaces/vegadeckgl.types.deckbase.html" class="tsd-signature-type" data-tsd-kind="Interface">DeckBase</a></h5>
							</li>
							<li>
								<h5>layers: <a href="interfaces/vegadeckgl.types.decklayerbase.html" class="tsd-signature-type" data-tsd-kind="Interface">DeckLayerBase</a></h5>
							</li>
							<li>
								<h5>luma: <a href="interfaces/vegadeckgl.types.lumabase.html" class="tsd-signature-type" data-tsd-kind="Interface">LumaBase</a></h5>
							</li>
						</ul>
						<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
					</li>
				</ul>
			</section>
		</section>
	</div>
	<div class="col-4 col-menu menu-highlight">
		<nav class="tsd-navigation primary">
			<ul>
				<li class="current ">
					<a href="modules.html">Exports</a>
				</li>
				<li class=" tsd-kind-namespace">
					<a href="modules/vegadeckgl.html">Vega<wbr>Deck<wbr>Gl</a>
				</li>
				<li class=" tsd-kind-namespace">
					<a href="modules/constants.html">constants</a>
				</li>
				<li class=" tsd-kind-namespace">
					<a href="modules/searchexpression.html">search<wbr>Expression</a>
				</li>
				<li class=" tsd-kind-namespace">
					<a href="modules/specs.html">specs</a>
				</li>
				<li class=" tsd-kind-namespace">
					<a href="modules/types.html">types</a>
				</li>
				<li class=" tsd-kind-namespace">
					<a href="modules/util.html">util</a>
				</li>
			</ul>
		</nav>
		<nav class="tsd-navigation secondary">
			<ul class="before-current">
				<li class=" tsd-kind-class">
					<a href="classes/viewer.html" class="tsd-kind-icon">Viewer</a>
				</li>
				<li class=" tsd-kind-variable">
					<a href="modules.html#colorschemes" class="tsd-kind-icon">color<wbr>Schemes</a>
				</li>
				<li class=" tsd-kind-variable">
					<a href="modules.html#version" class="tsd-kind-icon">version</a>
				</li>
				<li class=" tsd-kind-function">
					<a href="modules.html#use" class="tsd-kind-icon">use</a>
				</li>
			</ul>
		</nav>
	</div>
</div>
</div>
<div class="overlay"></div>